You can use Microsoft Entra ID (ME-ID) or Google Workspace with OpenID Connect (OIDC) authentication to enable your users to access the EBS product suite (that is: EBS Central, EBS shape and so on) with a single set of credentials. You can also enable dual authentication to include an additional login stage.
Process flow illustration - Microsoft Entra ID
The following diagram illustrates access to EBS Central with Microsoft Entra ID and OIDC authentication.
Process flow illustration - Google Workspace
The following diagram illustrates access to EBS Central with Google Workspace and OIDC authentication.
To enable OIDC authentication:
Configure reference data
The reference data settings for authentication are configured on the OIDC Issuers screen in reference data (accessed from the Systems ribbon).
The OIDC Issuer reference data grid contains the following fields:
-
Issuer - the relationship name (for example: AzureAD)
-
EBS Property - the EBS property description (for example: College Email, External Identifier, Person Code, User ID or Username)
-
Claim Name - the claim name (for example: preferred_username)
Configure institution settings
The institution settings for Microsoft Entra ID or Google Workspace authentication are configured on the Identity Server screen in institution settings (accessed from the Systems ribbon).
The fields on the Identity Server screen that are relevant to Microsoft Entra ID or Google Workspace authentication are described in the following table.
| This field | Holds this information... |
|---|---|
| URL for Identity Server | The URL for the Identity Server. |
| The client ID to use when logging into EBS Central with Identity Server | The client ID to use when logging into EBS Central with Identity Server. |
| Default OIDC issuer | The OpenID Connect (OIDC) issuer. |
| The Client Secret to use when logging into EBS Central with Identity Server | The client secret. |
| The ID token scope to use when logging into EBS Central with Identity Server |
The ID token scope to use when logging into EBS Central with Identity Server. This field must be set to one of the following:
|
You can configure authentication (for example: database information, whether to use dual authentication and so on) by defining the properties of the EBS shortcut parameters. Alternatively, you can use a configuration file, referenced in the properties of the EBS shortcut.
You can configure authentication in the following ways:
Shortcut parameters
You can configure the shortcut used to access EBS.
To configure the shortcut:
-
Right-click the shortcut.
-
Select the Properties option.
-
Select the Shortcut tab.
-
Edit the Target field.
The following information must be included in the shortcut target field:
-
OIDC - the OpenID Connect type - set to /oidc microsoft or /oidc google
-
EBSAuthentication - whether to use dual authentication - set to /EBSAuthentication TRUE to enable, FALSE to disable
-
DatabaseType - the database type (for example: /databasetype SQL)
-
DatabaseName - the database name (for example: /databasename <DatabaseName>)
If the DatabaseName is set to NULL, a Database field is displayed on the Login to EBS Central window where you can enter the relevant database.
-
DatabaseServername - the database server name (for example: /databaseservername <ServerName\DatabaseType>)
For example:
"C:\Program Files (x86)\TribalTech\EBS4 Client\TribalTech.EBS.Win.Shell.exe" /oidc "microsoft" /EBSAuthentication "TRUE" /databasetype "SQL" /databasename "<DatabaseName>" /databaseservername "<ServerName\DatabaseType>"
-
-
Click OK.
The target details are added to the shortcut.
Configuration file
You can use a configuration (.config) file to access EBS. The config file is referenced in the properties of the EBS shortcut with the institute parameter specifying the configuration file name (for example: "C:\Program Files (x86)\TribalTech\EBS4 Client\" /institute "InstitutionName").
You can encrypt a linked shortcut file. Refer to Communities for further information about encryption.
To configure the .config file:
-
Open Microsoft File Explorer.
-
Navigate to the location of the EBS installation (for example: C:\Program Files (x86)\TribalTech\EBS4 Client).
-
Create a configuration file with the relevant institution name (for example: Tribal.config).
The configuration file name is referenced in the shortcut Start in: field (for example: /institute "Tribal").
-
Right-click the relevant file and open with the relevant code editor (for example: Notepad++).
The following information must be included in the .config file:
-
OIDC - the OpenID Connect type - set to microsoft or google
-
EBSAuthentication - whether to use dual authentication, set to true to enable, false to disable
-
DatabaseType - the database type (for example: sql)
-
DatabaseName - the database name
If the DatabaseName is set to NULL, a Database field is displayed on the Login to EBS Central window where you can enter the relevant database.
-
DatabaseServername - the database server name
-
EBSAuthPwd - the EBSAuth user database password, only needed if you are not using the default password
You only need to specify the EBSAuth user database password if you are not using the default password. It is recommended that you encrypt the configuration file if you specify the EBSAuth user database password value. Refer to Communities for further information about encryption.
For example:
<configuration>
<configSections>
<section name="CustomerSettings" type="System.Configuration.NameValueFileSectionHandler"/>
</configSections>
<CustomerSettings>
<add key="databasetype" value="sql"/>
<add key="databasename" value="DatabaseName"/>
<add key="databaseservername" value="DatabaseName\ServerName"/>
<add key="EBSauthpwd" value="<PASSWORD>"/>
<add key="oidc" value="microsoft"/>
<add key="EBSauthentication" value="true"/>
</CustomerSettings>
</configuration>
-
-
Click Save.
-
Right-click the EBS shortcut and select the Properties option.
-
Select the Shortcut tab.
-
Edit the Start in field to include the config file name (for example: "C:\Program Files (x86)\TribalTech\EBS4 Client\" /institute "Tribal").
-
Click OK.
The configuration details are added to the shortcut.
You can log in to EBS in the following ways:
Log in with dual authentication enabled or disabled - Microsoft
You can log in to EBS with dual authentication (EBS authentication enabled or disabled in the configuration (.config) file or shortcut parameters).
In this example the OIDC value is set to 'Microsoft' in the shortcut parameters or configuration file.
To log in to EBS
-
Start EBS Central.
If dual authentication is enabled the Login to EBS Central window is displayed.
-
Enter login credentials and click OK. Alternatively, click the Sign in with Microsoft button.
If dual authentication is disabled the Sign in to your account window is displayed.
-
Select the relevant account.
EBS Central is displayed.
If you are accessing your account for the first time with OIDC authentication, a message is displayed.
-
Click Accept.
If there are authentication issues, an error message is displayed.
Log in with dual authentication enabled or disabled - Google Workspace
You can log in to EBS with dual authentication (EBS authentication enabled or disabled in the configuration (.config) file or shortcut parameters).
In this example the OIDC value is set to 'Google' in the shortcut parameters or configuration file.
To log in to EBS
-
Start EBS Central.
If dual authentication is enabled the Login to EBS Central window is displayed.
-
Enter login credentials and click OK. Alternatively, click the Sign in with Google button.
If dual authentication is disabled the Sign in with Google window is displayed.
-
Select the relevant account.
EBS Central is displayed.
-
Click Accept.
If there are authentication issues, an error message is displayed.
Refer to External authentication troubleshooting for further information.